package com.example.cfg;

// 导入 OpenAPI 类，用于创建和配置 OpenAPI 文档对象
import io.swagger.v3.oas.models.OpenAPI;
// 导入 Info 类，用于设置 OpenAPI 文档的基本信息，如标题、描述、版本等
import io.swagger.v3.oas.models.info.Info;
// 导入 Spring 框架的 Bean 注解，用于将方法返回的对象注册为 Spring 容器中的 Bean
import org.springframework.context.annotation.Bean;
// 导入 Spring 框架的 Configuration 注解，表明该类是一个配置类
import org.springframework.context.annotation.Configuration;
/**
 * 该类是一个 Spring 配置类，用于配置 OpenAPI 文档。
 * OpenAPI 是一种用于描述 RESTful API 的标准规范，借助此配置可以自动生成 API 文档。
 */
@Configuration
public class OpenAPIConfig {
    /**
     * 创建并配置一个 OpenAPI 实例，该实例包含了 API 文档的基本信息。
     * 此方法会返回一个配置好的 OpenAPI 对象，Spring 会将其注册为 Bean，
     * 以便在应用程序中使用，例如通过 Swagger UI 展示 API 文档。
     *
     * @return 配置好的 OpenAPI 实例
     */
    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title("网约车管理系统 API")
                        .description("用户服务和管理后台的接口文档")
                        .version("1.0.0"));
    }
}